Fix godoc formatting for all exported identifiers in symbolic package#32
Merged
kwesiRutledge merged 71 commits intomainfrom Mar 9, 2026
Merged
Fix godoc formatting for all exported identifiers in symbolic package#32kwesiRutledge merged 71 commits intomainfrom
kwesiRutledge merged 71 commits intomainfrom
Conversation
- Convert block-style /* ... */ doc comments to // style godoc comments - Ensure all doc comments start with the exported identifier name - Add missing doc comments for exported types with no documentation - Remove blank lines between doc comments and declarations - Fix various grammar and naming issues in comments Fixes 405 golint documentation warnings (0 remaining). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: kwesiRutledge <9002730+kwesiRutledge@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation comments for symbolic package
Fix godoc formatting for all exported identifiers in symbolic package
Feb 22, 2026
Collaborator
kwesiRutledge
left a comment
There was a problem hiding this comment.
Partial review; slowly working through the full set of comments.
|
|
||
| This function subtracts the current expression from another and returns the resulting expression. | ||
| */ | ||
| // Minus This function subtracts the current expression from another and returns the resulting expression. |
Collaborator
There was a problem hiding this comment.
Is this a typo? In this case, we subtract another expression from the current one.
| */ | ||
| // Check Checks to make sure that the constant is initialized properly. | ||
| // ConstantMatrix objects are always initialized properly, so this should always return | ||
| // no error. |
Collaborator
There was a problem hiding this comment.
Are they? I think we should instead check the dimensions of each row to make sure that they match...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
All doc comments in the
symbolicpackage used a non-standard/* Name\nDescription:\n text\n*/block style that violated godoc conventions — specifically, comments must begin with the name of the declared identifier.Changes
/* Description: ... */to// Name ...godoc format across all 28 files insymbolic/BasicEnvironment,KMatrix,Constraint,Environment, etc.)...placeholder comments with meaningful descriptions (Dims,Transpose,IsConstraint,ToExpression,VectorMultiplyTemplate,Copy,ScaleBy, and others)matrix_constraint.gowhereAt()referred to a "vector" constraint instead of "matrix" constraintBefore / After
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.